ParameterInfo Struct Reference

Controller Parameter Info. More...

#include <ivsteditcontroller.h>

Public Types

enum  ParameterFlags {
  kCanAutomate = 1 << 0, kIsReadOnly = 1 << 1, kIsWrapAround = 1 << 2, kIsList = 1 << 3,
  kIsProgramChange = 1 << 15, kIsBypass = 1 << 16
}

Data Fields

ParamID id
 unique identifier of this parameter (named tag too)
String128 title
 parameter title (e.g. "Volume")
String128 shortTitle
 parameter shortTitle (e.g. "Vol")
String128 units
 parameter unit (e.g. "dB")
int32 stepCount
 number of discrete steps (0: continuous, 1: toggle, discrete value otherwise
ParamValue defaultNormalizedValue
 default normalized value [0,1] (in case of discrete value: defaultNormalizedValue = defDiscreteValue / stepCount)
UnitID unitId
 id of unit this parameter belongs to (see VST 3 Units)
int32 flags
 ParameterFlags (see below).

Detailed Description

Controller Parameter Info.


Member Enumeration Documentation

Enumerator:
kCanAutomate 

parameter can be automated

kIsReadOnly 

parameter cannot be changed from outside (implies that kCanAutomate is false)

kIsWrapAround 

attempts to set the parameter value out of the limits will result in a wrap around [SDK 3.0.2]

kIsList 

parameter should be displayed as list in generic editor or automation editing [SDK 3.1.0]

kIsProgramChange 

parameter is a program change (unitId gives info about associated unit

  • see vst3UnitPrograms)
kIsBypass 

special bypass parameter (only one allowed): Plug-in can handle bypass

(highly recommended to export a bypass parameter for effect Plug-in)


Field Documentation

unique identifier of this parameter (named tag too)

parameter title (e.g. "Volume")

parameter shortTitle (e.g. "Vol")

parameter unit (e.g. "dB")

number of discrete steps (0: continuous, 1: toggle, discrete value otherwise

(corresponding to max - min, for example: 127 for a min = 0 and a max = 127) - see vst3parameterIntro)

default normalized value [0,1] (in case of discrete value: defaultNormalizedValue = defDiscreteValue / stepCount)

id of unit this parameter belongs to (see VST 3 Units)

ParameterFlags (see below).

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.